Billers List

Retrieves the biller data from the BillPay Connector once the biller file from Mastercard has been uploaded.
Displays the list of billers to the end user in their UI.

Endpoint

Method: POST
URL: {{URL}}/PL/jsonrpc

Headers

Key	Type	Required	Description
Content-Type	string	Yes	application/json

---

Request

{
    "method": "BillpayConnectorService.BillersList",
    "id": "1",
    "params": {
        "payload": {
            "pageNumber": 1,
            "pageSize": 10
        },
        "api": {
            "credential": "Basic bS5rdW1hcisxQG5ldHhkLmNvbToyYjVlMDIzMDg1NjU0YTE3ODUwZWE0N2Q1NWFlNWViNA==",
            "signature": "MEYCIQCB41k2IAkG6Mh5nspFJDEj/kc9xhmZI47G8YysoZ0J9wIhANo0u7wLsY0vAzArK08WeReBRCUAeecFXC5icfLr7vN3",
            "keyId": "231008"
        }
    }
}

Response: 200

Request Parameters

Parameter	Description
method Mandatory	String API method name Constant: billpayConnectorService.BillersList
id Mandatory	String Unique request identifier
pageNumber Mandatory	Integer Page number
pageSize Mandatory	Integer Page size
credential Mandatory	String API credential for authentication
signature Mandatory	String Signature for request validation
keyId Mandatory	String Key ID for authentication

{
    "id": "1",
    "result": {
        "biller": [
            {
                "id": "67d15c23544942f01d70e8d9",
                "addresses": [
                    {
                        "addressLine1": "PO Box 3150",
                        "city": "Houston",
                        "country": "USA",
                        "state": "TX",
                        "type": "Standard",
                        "zipCode": "77253"
                    },
                    {
                        "addressLine1": "406 West Grand Parkway South",
                        "city": "Katy",
                        "country": "USA",
                        "state": "TX",
                        "type": "Standard",
                        "zipCode": "77494"
                    }
                ],
                "billerClass": "Electric / Gas / Power / Water",
                "billerId": "1430581337",
                "billerName": "HARRIS CO MUD 86",
                "billerType": "Gateway",
                "masks": [
                    {
                        "maskFormat": "30422-##########",
                        "maskLength": "16",
                        "maskRejex": "30422-\\d{10}"
                    }
                ]
            },
            {
                "id": "67d15c23544942f01d70e8d8",
                "addresses": [
                    {
                        "addressLine1": "406 West Grand Parkway South Suite 260",
                        "city": "Katy",
                        "country": "USA",
                        "state": "TX",
                        "type": "Standard",
                        "zipCode": "77494"
                    },
                    {
                        "addressLine1": "PO Box 3150",
                        "city": "Houston",
                        "country": "USA",
                        "state": "TX",
                        "type": "Standard",
                        "zipCode": "77253"
                    }
                ],
                "billerClass": "Electric / Gas / Power / Water",
                "billerId": "1430580922",
                "billerName": "HARRIS CO MUD 81",
                "billerType": "Gateway",
                "masks": [
                    {
                        "maskFormat": "30414-##########",
                        "maskLength": "16",
                        "maskRejex": "30414-\\d{10}"
                    }
                ]
            }
        ]
    },
    "jsonrpc": "2.0"
}